home *** CD-ROM | disk | FTP | other *** search
/ SPACE 1 / SPACE - Library 1 - Volume 1.iso / telecomm / 532 / frzdterm / fzdsxfer.doc < prev    next >
Text File  |  1991-12-24  |  8KB  |  210 lines
  1. FZDSXFER.DOC
  2. ======== ===
  3.  
  4.                          FreeZe Dried Software Protocols
  5.                          ------ ----- -------- ---------
  6.  
  7.                            Program and Documentation 
  8.                 Copyright ©1991 Sean Price and Aaron Hopkins of FzDS
  9.                               All Rights Reserved.
  10.  
  11.             Summary of commands for FreeZe Dried Software Protocols,
  12.                               Beta-Test version .20
  13.  
  14.     This program is in its development and testing stages.  We will be adding 
  15. more protocols and increasing the efficiency and thoroughput of this program. 
  16. After it is perfected, it will become an internal part of the FreeZe Dried 
  17. Terminal and possibly UNet and UBBS/III.  If you find a problem with it, 
  18. please report it to the authors.  If you don't, the problem may reoccur in 
  19. later versions of this and other programs which use it.  By releasing this 
  20. Beta-test version, we are asking you the user to test it out for us in all 
  21. possible situations and let us know if it doesn't meet your standards so we 
  22. may improve it.
  23.  
  24. DISCLAIMER:  This program has been thoroughly tested and it is hoped that it 
  25.              contains no errors.  But, the authors will accept no 
  26.              responsibility for any damages caused by this program.  There 
  27.              are no warranties, whether written or implied regarding the use 
  28.              of this program.  You use it at your own risk!
  29.  
  30.  
  31. How To Reach Us:
  32. --- -- ----- --
  33.  
  34. Any problems, comments, or suggestions regarding FZDSXFER.TTP may be sent to 
  35. the authors in the following ways:
  36.  
  37. a) Leave a post or feedback to the sysops on:
  38.      Hitchhiker's Guide to the Galaxy (213) 379-3796  300-19.2k HST  8/N/1
  39.      The main support board for all FreeZe Dried Software Products
  40. b) E-Mail S.PRICE19 on GEnie
  41. c) Send mail to:
  42.                         Aaron Hopkins
  43.                         RE: FreeZe Dried Protocols
  44.                         1213 Walnut Avenue
  45.                         Manhattan Beach, CA  90266
  46.  
  47. If you have specifications (Book Reference, Text File, etc.) on Z-Modem, Puma,
  48. Lynx, Super 8K, K9XModem, etc. protocols, or feel that you can help in any 
  49. way with this project, please drop us a note.  We plan on addressing any 
  50. shortcomings in this program, along with adding every conceivable protocol 
  51. possible.  If you would like to see a certain protocol which we haven't 
  52. listed, let us know.
  53.  
  54.  
  55. Rules For Use:
  56. ----- --- ---
  57.  
  58. By now I'm sure you've read the standard shareware plea a thousand times, so 
  59. I will not bother to repeat it again for your enjoyment.  If you like this 
  60. program and use it regularly, all we ask is that you send in a $10 donation 
  61. to the above address.  We can't force you to, as this works on the honor 
  62. system.  (It is not necessary for registered users of FzDSTerm or UBBS to 
  63. send in this donation; you have already done your part, enjoy!)
  64.  
  65. If you have FzP installed in a BBS system as an external protocol, we ask 
  66. that you mention "FreeZe Dried Dried Software Protocols" somewhere in an 
  67. "information about this BBS" type of bulletin along with the above address, 
  68. for further information.  We also would hope that you make an archived copy 
  69. of this documentation and the program available to your ST users, so they may 
  70. use it also.
  71.  
  72. This software may be distributed freely as long at it includes this 
  73. documentation, and is not "sold" to anyone except to pay for the price of the 
  74. media and shipping prices.  Upload this everywhere!
  75.  
  76.  
  77. Command Line Structure:
  78. ------- ---- ---------
  79.  
  80. FreeZe Dried Software Protocols currently supports Xmodem CRC, Xmodem 1K,
  81. Ymodem Batch, Ymodem-G Batch, and Fmodem Batch.  The commands are passed by 
  82. way of a command line when executed by being typed at a .TTP dialog or passed 
  83. by a shell.  The following deals with the structure of the parameters being 
  84. passed on the command line:
  85.  
  86. FzDS Protocols defaults to receive mode.  All commands must be seperated by 
  87. a space.  FzP accepts wild cards as filenames for batch modes.  If a wildcard 
  88. is used in a single file mode, FzDS Protocols will use the first matching 
  89. file.  Filenames can include a path.
  90.  
  91.  
  92. Format:  (Options in brackets are optional.)
  93. -X/-K/-Y/-G/-F {-S -C -D -H -M{x} -Ix -Ox} {x:\path\} {{x:\path\}file.ext ...}
  94. ^-Must have one  ^-Switches are optional. They can be in any order,
  95.   and only one     or not included at all.  "x"s are parameters.
  96.   command.
  97.  
  98. A path without a filename will reset the default receive/send path in FzP. 
  99. Anywhere in the program where a filename exists without a path, this default 
  100. path will be added to it.
  101.  
  102. At least one filename must be included for ALL sends.  If sending using Batch 
  103. protocols, more than one file may be included.
  104.  
  105. XModem is the only protocol that requires a filename for a receive. 
  106. Filenames will be ignored when using batch protocols.
  107.  
  108.  
  109. Commands:
  110. --------
  111.  
  112. -X filename.ext
  113.    Send using Xmodem CRC/Receive using Xmodem CRC or Xmodem 1K (Automatically
  114.    detects block size to use.)
  115.    Example:-X -S D:\SCUM\TEST.LZH 
  116.            Sends D:\SCUM\TEST.LZH using Xmodem CRC
  117.  
  118. -K filename.ext
  119.    Send using Xmodem 1K (Not needed for Receive because -X automatically
  120.    detects block size.)
  121.    Example:-K -S TEST.LZH
  122.            Sends TEST.LZH using Xmodem 1K
  123.  
  124. -Y {filename.ext ...}
  125.    Send/Receive using Ymodem Batch
  126.    Example:-Y -S TEST.LZH TEST2.LZH
  127.            Sends TEST.LZH and TEST2.LZH using Ymodem Batch
  128.  
  129.    Example:-Y D:\SCUM\
  130.            Receives using Ymodem Batch.  All received files will be put
  131.            in the D:\SCUM\ directory.
  132.  
  133.    Example:-Y -S *.LZH
  134.            Sends all files matching *.LZH using Ymodem Batch
  135.  
  136. -G {filename.ext ...}
  137.    Send/Receive using Ymodem-G Batch
  138.    Example:-G -S TEST.LZH TEST2.LZH
  139.            Sends TEST.LZH and TEST2.LZH using Ymodem-G Batch
  140.  
  141.    Example:-G
  142.            Receives using Ymodem-G Batch
  143.  
  144.    Example:-G -S *.LZH
  145.            Sends all files matching *.LZH using Ymodem-G Batch
  146.  
  147. -F {filename.ext ...}
  148.    Send/Receive using Fmodem Batch
  149.    Example:-F -S TEST.LZH TEST2.LZH
  150.            Sends TEST.LZH and TEST2.LZH using Fmodem Batch
  151.  
  152.    Example:-F
  153.            Receives using Fmodem Batch
  154.  
  155.    Example:-F -S *.LZH
  156.            Sends all files matching *.LZH using Fmodem Batch
  157.  
  158.  
  159. Switches:
  160. --------
  161.  
  162. -S 
  163.    Send mode (upload).  Without this switch, FzP will default to receive 
  164.    mode (download).
  165.  
  166. -C 
  167.    Turn on Carrier Detect.  If the carrier detect drops during any portion of 
  168.    a transmission, FzP will abort and exit.
  169.  
  170. -D 
  171.    Delete incompletely transferred files while in receive mode.
  172.  
  173. -N 
  174.    Overwrites a file if one currently exists with that name.  Otherwise, the 
  175.    transfer is aborted.
  176.  
  177. -H 
  178.    Turns on RTS/CTS mode for High Speed modems.  This will wait for the send 
  179.    buffer to clear before adding anything to it.  (This must be set to on for 
  180.    XModem 1K, Ymodem, Ymodem-G, and Fmodem Send if you are having problems 
  181.    sending files with a high speed modem.)
  182.  
  183. -M{xxxx} 
  184.    Resets the value for metering.  This is the maximum number of bytes FzP 
  185.    will put in the transmit buffer.  (The default is one byte below the high 
  186.    water mark.  Usually 767 for a 1k send buffer, 191 for a 256 byte 
  187.    buffer.)  -M without any options sets metering to 16 bytes.  Decreasing
  188.    this number will decrease output thoroughput, but will also help with
  189.    problems regarding high speed modems and hardware flow control.  This may 
  190.    be needed for sending at high speeds.  (If using FreeZe Dried Software 
  191.    Terminal version 2.03 or earlier this should be set to -M767.)
  192.  
  193. -Ofilename.ext 
  194.    Creates a text file with the given filename and stores the names of
  195.    successfully transferred files in it.  Filename must be immediately after
  196.    the -O.  (This is used to return a list of files back to the calling 
  197.    program.)
  198.    Example:-Y -OGOT.TXT
  199.            Receives using Ymodem Batch and stores the filenames of all
  200.            successfully received files in GOT.TXT
  201.  
  202. -Ifilename.ext 
  203.    For batch modes only.  Protocol looks for text file with the given 
  204.    filename, and attempts to send all files contained in it.  Filenames may 
  205.    or may not include a path, and may use wildcards.  Only the first 100 
  206.    matching files are sent.
  207.    Example:-Y -ISEND.TXT
  208.            Sends all files listed in SEND.TXT using Ymodem Batch. 
  209.  
  210.